Node.js Publish a Package

உங்கள் Node.js தொகுப்பை npm பதிவேட்டில் வெளியிட கற்றுக்கொள்ளுங்கள்

What Does it Mean to Publish a Package?

தொகுப்பு வெளியிடுவது என்பது உங்கள் Node.js தொகுதி அல்லது திட்டத்தை npm பதிவேட்டின் மூலம் மற்றவர்கள் நிறுவி பயன்படுத்துவதற்கு கிடைக்கச் செய்வதாகும்.

திறந்த மூல நூலகங்கள் மற்றும் கருவிகள் Node.js சமூகத்துடன் இந்த வழியில் பகிரப்படுகின்றன.

நீங்கள் ஒரு தொகுப்பை வெளியிடும்போது, அது npm install your-package-name பயன்படுத்தி யாரும் நிறுவக்கூடியதாக மாறும்.

⚠️ குறிப்பு:

உங்கள் தொகுப்பு மதிப்பை வழங்குகிறது என்பதை உறுதிப்படுத்தவும், மேலும் அது NPM இல் இருக்கும் ஏற்கனவே உள்ள தொகுப்பின் நகல் அல்ல என்பதை உறுதிப்படுத்தவும்.

தனிப்பட்ட பயன்பாடு

உள் திட்டங்களுக்கான தொகுப்புகள்

பொது வெளியீடு

உலகளாவிய பயன்பாட்டிற்கான தொகுப்புகள்

அமைப்பு வெளியீடு

அமைப்பு உள்ளே பயன்படுத்த தொகுப்புகள்

Preparing Your Package

1. தொகுப்பைத் தொடங்கவும்

ஒரு புதிய அடைவை உருவாக்கி உங்கள் தொகுப்பைத் தொடங்கவும்:

mkdir my-package
cd my-package
npm init -y

2. அத்தியாவசிய கோப்புகள்

ஒரு தொகுப்பில் இந்த முக்கிய கோப்புகள் இருக்க வேண்டும்:

package.json

உங்கள் தொகுப்பைப் பற்றிய மெட்டாடேட்டா

README.md

ஆவணங்கள் (மார்க்டவுனை ஆதரிக்கிறது)

index.js

முக்கிய நுழைவு புள்ளி (அல்லது package.json இல் குறிப்பிடவும்)

LICENSE

பயன்பாட்டு விதிமுறைகள் (MIT, ISC, முதலியன)

.gitignore

node_modules, பதிவுகள் போன்றவற்றை விலக்க

.npmignore

வெளியிடப்பட்ட தொகுப்பிலிருந்து கோப்புகளை விலக்க (விருப்பத்தேர்வு)

3. Package.json Essentials

உங்கள் package.json இல் இந்த குறைந்தபட்ச புலங்கள் உள்ளன என்பதை உறுதிப்படுத்தவும்:

{
  "name": "your-package-name",
  "version": "1.0.0",
  "description": "A brief description of your package",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": ["keyword1", "keyword2"],
  "author": "Your Name ",
  "license": "MIT"
}

💡 உதவிக்குறிப்பு:

உங்கள் தொகுப்பு பெயர் தனித்துவமானதாகவும், விவரணை தெளிவாகவும் இருக்க வேண்டும். முக்கிய சொற்கள் மற்றவர்கள் உங்கள் தொகுப்பைக் கண்டுபிடிக்க உதவும்.

Creating an npm Account

1. பதிவு செய்யுங்கள்

உங்களிடம் கணக்கு இல்லையென்றால் npmjs.com/signup இல் ஒரு கணக்கை உருவாக்கவும்.

2. உங்கள் மின்னஞ்சலைச் சரிபார்க்கவும்

வெளியிடுவதற்கு முன் உங்கள் மின்னஞ்சலைச் சரிபார்க்கவும் மற்றும் உங்கள் கணக்கைச் சரிபார்க்கவும்.

3. CLI வழியாக உள்நுழைக

உங்கள் டெர்மினலைத் திறந்து இயக்கவும்:

npm login

உங்களிடம் கேட்கப்படும்:

  • பயனர்பெயர்
  • கடவுச்சொல்
  • மின்னஞ்சல் (உங்கள் npm கணக்குடன் பொருந்த வேண்டும்)
  • ஒரு முறை கடவுச்சொல் (2FA இயக்கப்பட்டிருந்தால்)

4. உள்நுழைந்த நிலையைச் சரிபார்க்கவும்

npm whoami

Publishing Your Package

1. பெயர் கிடைக்கும் தன்மையைச் சரிபார்க்கவும்

npm view <package-name>

அந்த பெயருடன் தொகுப்பு ஏற்கனவே இல்லையென்றால், நீங்கள் அந்த பெயரைப் பயன்படுத்தலாம்.

அது இருந்தால், உங்கள் package.json இல் வேறு பெயரை நீங்கள் தேர்வு செய்ய வேண்டும்.

2. தொகுப்பை உள்ளூரில் சோதிக்கவும்

வெளியிடுவதற்கு முன், உங்கள் தொகுப்பை உள்ளூரில் சோதிக்கவும்:

# In your package directory
npm link

# In another project directory
npm link <package-name>

3. npm பதிவேட்டில் வெளியிடவும்

# First, make sure you're in the right directory
cd path/to/your/package

# Publish to the public npm registry
npm publish

4. குறிப்பிட்ட டேக் உடன் வெளியிடவும்

npm publish --tag beta

5. பொது தொகுப்பை வெளியிடவும்

npm publish --access public

🚀 வெற்றிகரமான வெளியீட்டிற்கான உதவிக்குறிப்புகள்:

  • வெளியிடுவதற்கு முன் உங்கள் தொகுப்பை முழுமையாகச் சோதிக்கவும்
  • ஒரு தெளிவான README.md கோப்பைச் சேர்க்கவும்
  • உங்கள் தொகுப்பு பெயர் தனித்துவமானது என்பதை உறுதிப்படுத்தவும்
  • உங்கள் npm கணக்கில் உள்நுழைந்துள்ளீர்கள் என்பதை உறுதிப்படுத்தவும்

Updating Your Package

1. பதிப்பு எண்ணைப் புதுப்பிக்கவும்

உங்கள் தொகுப்பு பதிப்பைப் புதுப்பிக்க செமான்டிக் பதிப்பு மேலாண்மையைப் (SemVer) பயன்படுத்தவும்:

பேட்ச் வெளியீட்டிற்கு (பிழை திருத்தங்கள்)

npm version patch

சிறிய வெளியீட்டிற்கு (பின்னோக்கி இணக்கமான அம்சங்கள்)

npm version minor

முக்கிய வெளியீட்டிற்கு (உடைக்கும் மாற்றங்கள்)

npm version major

2. மாற்றப் பதிவைப் புதுப்பிக்கவும்

இந்த பதிப்பில் உள்ள மாற்றங்களை ஆவணப்படுத்த உங்கள் CHANGELOG.md ஐப் புதுப்பிக்கவும்.

3. புதுப்பிப்பை வெளியிடவும்

npm publish

4. வெளியீட்டைக் குறிக்கவும் (விருப்பத்தேர்வு)

நீங்கள் Git ஐப் பயன்படுத்தினால், வெளியீட்டிற்கான குறியை உருவாக்கவும்:

git tag -a v1.0.0 -m "Initial release"
git push origin v1.0.0

Managing Published Packages

தொகுப்பை வெளியிடாது செய்தல்

npm பதிவேட்டிலிருந்து ஒரு தொகுப்பை அகற்ற:

# Unpublish a specific version
npm unpublish <package-name>@<version>

# Unpublish the entire package (only works within 72 hours of publishing)
npm unpublish <package-name> --force

குறிப்பு:

வெளியிடாது செய்வது கடுமையாக ஊக்குவிக்கப்படுகிறது, ஏனெனில் இது உங்கள் தொகுப்பைச் சார்ந்திருக்கும் மற்ற திட்டங்களை உடைக்கும். அதற்கு பதிலாக npm deprecate பயன்படுத்துவதைக் கவனியுங்கள்.

தொகுப்பைக் கைவிடுதல்

நீங்கள் பயனர்கள் ஒரு பதிப்பை நிறுவுவதைத் தடுக்க விரும்பினால் ஆனால் அதை இருக்கும் பயனர்களுக்குக் கிடைக்க வைக்க:

# Deprecate a specific version
npm deprecate <package-name>@<version> "message"

# Example
npx deprecate my-package@1.0.0 "This version is no longer maintained. Please upgrade to v2.0.0"

உரிமையை மாற்றுதல்

மற்றொரு பயனர் அல்லது அமைப்புக்கு ஒரு தொகுப்பை மாற்ற:

npm owner add <username> <package-name>

🚫 முக்கியமானது:

தொகுப்புகளை வெளியிடாது செய்வது npm சமூகத்தில் மோசமான பழக்கமாகக் கருதப்படுகிறது. உங்கள் தொகுப்பைப் பராமரிக்க முடியாவிட்டால், அதைக் கைவிடுவது நல்லது.

Best Practices

செமான்டிக் பதிப்பு மேலாண்மையைப் பின்பற்றவும் - MAJOR.MINOR.PATCH பதிப்பு எண்களைத் தகுந்தவாறு பயன்படுத்தவும்
நல்ல ஆவணங்களை எழுதுங்கள் - உங்கள் README இல் தெளிவான பயன்பாட்டு எடுத்துக்காட்டுகளைச் சேர்க்கவும்
சோதனைகளைச் சேர்க்கவும் - யூனிட் சோதனைகளைச் சேர்க்கவும் மற்றும் அவற்றை எவ்வாறு இயக்குவது என்பதை ஆவணப்படுத்தவும்
.npmignore ஐப் பயன்படுத்தவும் - தேவையான கோப்புகளை மட்டுமே வெளியிடவும்
முக்கிய சொற்களைச் சேர்க்கவும் - மற்றவர்கள் உங்கள் தொகுப்பைக் கண்டுபிடிக்க உதவுங்கள்
சரியான உரிமத்தைத் தேர்ந்தெடுக்கவும் - உங்கள் விதிமுறைகளைப் பயனர்களுக்குத் தெளிவுபடுத்துங்கள்
மாற்றப் பதிவைப் பராமரிக்கவும் - பதிப்புகளுக்கு இடையிலான மாற்றங்களை ஆவணப்படுத்தவும்
தொடர்ச்சியான ஒருங்கிணைப்பைப் பயன்படுத்தவும் - சோதனை மற்றும் வெளியீட்டை தானியக்கமாக்குங்கள்

Summary

npm க்கு தொகுப்புகளை வெளியிடுவது உங்கள் குறியீட்டை Node.js சமூகத்துடன் பகிர ஒரு சிறந்த வழியாகும்.

நீங்கள் சிறந்த நடைமுறைகளைப் பின்பற்றி உங்கள் தொகுப்புகளை நன்கு பராமரித்தால், மற்றவர்கள் அதன் மீது கட்டமைக்கக்கூடிய மதிப்புமிக்க கருவிகளை நீங்கள் பங்களிக்கலாம்.

பகிர்வு

உங்கள் தீர்வுகளை உலகத்துடன் பகிர்ந்து கொள்ளுங்கள்

சமூகம்

Node.js சமூகத்திற்கு பங்களிக்கவும்

கருவிகள்

மற்றவர்கள் பயன்படுத்தக்கூடிய கருவிகளை உருவாக்குங்கள்

கற்றல்

மற்றவர்களின் குறியீட்டிலிருந்து கற்றுக்கொள்ளுங்கள்

💎 நினைவில் கொள்ளுங்கள்:

பெரிய சக்தியுடன் பெரிய பொறுப்பு வருகிறது. நீங்கள் ஒரு தொகுப்பை வெளியிடும்போது, அதைப் பராமரிக்க அல்லது அதன் நிலையைப் பயனர்களுக்குத் தெளிவாகத் தொடர்பு கொள்ள நீங்கள் ஒரு உறுதிப்பாட்டைச் செய்கிறீர்கள்.

Exercise

தொகுப்பை npm க்கு வெளியிட சரியான கட்டளையைத் தேர்ந்தெடுக்கவும்.

npm deploy
✗ தவறு! "npm deploy" என்பது npm இல் ஒரு செல்லுபடியாகும் கட்டளை அல்ல
npm release
✗ தவறு! "npm release" என்பது npm இல் ஒரு செல்லுபடியாகும் கட்டளை அல்ல
npm publish
✓ சரி! "npm publish" என்பது npm பதிவேட்டில் ஒரு தொகுப்பை வெளியிட பயன்படும் சரியான கட்டளை
npm push
✗ தவறு! "npm push" என்பது npm இல் ஒரு செல்லுபடியாகும் கட்டளை அல்ல

பின்வரும் கட்டளைகளில் எது ஒரு தொகுப்பின் பேட்ச் பதிப்பைப் புதுப்பிக்கும்?

npm update patch
✗ தவறு! "npm update patch" என்பது சரியான கட்டளை அல்ல
npm version patch
✓ சரி! "npm version patch" என்பது ஒரு தொகுப்பின் பேட்ச் பதிப்பைப் புதுப்பிக்கும் சரியான கட்டளை
npm patch
✗ தவறு! "npm patch" என்பது npm இல் ஒரு செல்லுபடியாகும் கட்டளை அல்ல
npm bump patch
✗ தவறு! "npm bump patch" என்பது npm இல் ஒரு செல்லுபடியாகும் கட்டளை அல்ல